Google Slides Presentations API

openapi: 3.2.0
info:
  title: Google Slides Pages Presentations API
  description: 'Reads and writes Google Slides presentations. The Google Slides API lets you create and modify Google Slides presentations. Apps can integrate with the Slides API to create presentations, add and modify slides, format text and shapes, embed charts and images, and perform batch updates to presentations programmatically.

    '
  version: v1
  contact:
    name: Google Workspace Developer Support
    url: https://developers.google.com/slides/api/support
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
  x-logo:
    url: https://www.gstatic.com/images/branding/product/2x/slides_2020q4_48dp.png
servers:
- url: https://slides.googleapis.com
  description: Google Slides API Production Server
security:
- OAuth2: []
tags:
- name: Presentations
  description: Operations on Google Slides presentations
paths:
  /v1/presentations:
    post:
      summary: Google Slides Create Presentation
      description: 'Creates a blank presentation using the title given in the request. If a presentationId is provided, it is used as the ID of the new presentation. Otherwise, a new ID is generated. Other fields in the request, including any provided content, are ignored.

        '
      operationId: createPresentation
      tags:
      - Presentations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Presentation'
            examples:
              CreateBlankPresentation:
                summary: Create a blank presentation with a title
                value:
                  title: My New Presentation
      responses:
        '200':
          description: Successful response containing the created presentation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Presentation'
              examples:
                Createpresentation200Example:
                  summary: Default createPresentation 200 response
                  x-microcks-default: true
                  value:
                    presentationId: '500123'
                    title: Example Title
                    pageSize: {}
                    slides:
                    - objectId: '500123'
                      pageType: SLIDE
                      pageElements: {}
                      revisionId: '500123'
                    masters:
                    - objectId: '500123'
                      pageType: SLIDE
                      pageElements: {}
                      revisionId: '500123'
                    layouts:
                    - objectId: '500123'
                      pageType: SLIDE
                      pageElements: {}
                      revisionId: '500123'
                    locale: example_value
                    revisionId: '500123'
                    notesMaster:
                      objectId: '500123'
                      pageType: SLIDE
                      pageElements:
                      - {}
                      revisionId: '500123'
        '400':
          description: Bad Request - Invalid input parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createpresentation400Example:
                  summary: Default createPresentation 400 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createpresentation401Example:
                  summary: Default createPresentation 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Createpresentation403Example:
                  summary: Default createPresentation 403 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/presentations/{presentationId}:
    get:
      summary: Google Slides Get Presentation
      description: 'Gets the latest version of the specified presentation.

        '
      operationId: getPresentation
      tags:
      - Presentations
      parameters:
      - $ref: '#/components/parameters/PresentationId'
      responses:
        '200':
          description: Successful response containing the presentation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Presentation'
              examples:
                Getpresentation200Example:
                  summary: Default getPresentation 200 response
                  x-microcks-default: true
                  value:
                    presentationId: '500123'
                    title: Example Title
                    pageSize: {}
                    slides:
                    - objectId: '500123'
                      pageType: SLIDE
                      pageElements: {}
                      revisionId: '500123'
                    masters:
                    - objectId: '500123'
                      pageType: SLIDE
                      pageElements: {}
                      revisionId: '500123'
                    layouts:
                    - objectId: '500123'
                      pageType: SLIDE
                      pageElements: {}
                      revisionId: '500123'
                    locale: example_value
                    revisionId: '500123'
                    notesMaster:
                      objectId: '500123'
                      pageType: SLIDE
                      pageElements:
                      - {}
                      revisionId: '500123'
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getpresentation401Example:
                  summary: Default getPresentation 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getpresentation403Example:
                  summary: Default getPresentation 403 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '404':
          description: Not Found - Presentation does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Getpresentation404Example:
                  summary: Default getPresentation 404 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /v1/presentations/{presentationId}:batchUpdate:
    post:
      summary: Google Slides Batch Update Presentation
      description: 'Applies one or more updates to the presentation. Each request is validated before being applied. If any request is not valid, then 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 that of the requests.

        '
      operationId: batchUpdatePresentation
      tags:
      - Presentations
      parameters:
      - $ref: '#/components/parameters/PresentationId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchUpdatePresentationRequest'
            examples:
              InsertText:
                summary: Insert text into a shape
                value:
                  requests:
                  - insertText:
                      objectId: MyShape_01
                      text: Hello World
                      insertionIndex: 0
              CreateSlide:
                summary: Create a new slide
                value:
                  requests:
                  - createSlide:
                      slideLayoutReference:
                        predefinedLayout: TITLE_AND_BODY
                      insertionIndex: 1
      responses:
        '200':
          description: Successful response containing update replies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchUpdatePresentationResponse'
              examples:
                Batchupdatepresentation200Example:
                  summary: Default batchUpdatePresentation 200 response
                  x-microcks-default: true
                  value:
                    presentationId: '500123'
                    replies:
                    - {}
                    writeControl:
                      requiredRevisionId: '500123'
        '400':
          description: Bad Request - One or more requests are invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Batchupdatepresentation400Example:
                  summary: Default batchUpdatePresentation 400 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Batchupdatepresentation401Example:
                  summary: Default batchUpdatePresentation 401 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '403':
          description: Forbidden - Insufficient permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Batchupdatepresentation403Example:
                  summary: Default batchUpdatePresentation 403 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
        '404':
          description: Not Found - Presentation does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Batchupdatepresentation404Example:
                  summary: Default batchUpdatePresentation 404 response
                  x-microcks-default: true
                  value:
                    error:
                      code: 10
                      message: example_value
                      status: example_value
                      details:
                      - {}
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UpdateTableColumnPropertiesRequest:
      type: object
      description: Updates the properties of a Table column.
      properties:
        objectId:
          type: string
          description: The object ID of the table.
          example: '500123'
        columnIndices:
          type: array
          description: The list of zero-based indices specifying which columns to update.
          items:
            type: integer
          example: []
        tableColumnProperties:
          $ref: '#/components/schemas/TableColumnProperties'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
    UpdatePagePropertiesRequest:
      type: object
      description: Updates the properties of a Page.
      properties:
        objectId:
          type: string
          description: The object ID of the page the update is applied to.
          example: '500123'
        pageProperties:
          $ref: '#/components/schemas/PageProperties'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
    OptionalColor:
      type: object
      description: 'A color that can either be fully opaque or fully transparent.

        '
      properties:
        opaqueColor:
          $ref: '#/components/schemas/OpaqueColor'
    List:
      type: object
      description: A list describes the look and feel of bullets belonging to paragraphs.
      properties:
        listId:
          type: string
          description: The ID of the list.
          example: '500123'
        nestingLevel:
          type: object
          description: 'A map of nesting levels to the properties of bullets at the associated level.

            '
          additionalProperties:
            $ref: '#/components/schemas/NestingLevel'
          example: example_value
    OutlineFill:
      type: object
      description: The fill of the outline.
      properties:
        solidFill:
          $ref: '#/components/schemas/SolidFill'
    CreateImageResponse:
      type: object
      description: The result of creating an image.
      properties:
        objectId:
          type: string
          description: The object ID of the created image.
          example: '500123'
    UpdateTableRowPropertiesRequest:
      type: object
      description: Updates the properties of a Table row.
      properties:
        objectId:
          type: string
          description: The object ID of the table.
          example: '500123'
        rowIndices:
          type: array
          description: The list of zero-based indices specifying which rows to update.
          items:
            type: integer
          example: []
        tableRowProperties:
          $ref: '#/components/schemas/TableRowProperties'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
    SheetsChartProperties:
      type: object
      description: The properties of a SheetsChart.
      properties:
        chartImageProperties:
          $ref: '#/components/schemas/ImageProperties'
    Line:
      type: object
      description: 'A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector.

        '
      properties:
        lineCategory:
          type: string
          description: The category of the line.
          enum:
          - LINE_CATEGORY_UNSPECIFIED
          - STRAIGHT
          - BENT
          - CURVED
          example: LINE_CATEGORY_UNSPECIFIED
        lineType:
          type: string
          description: The type of the line.
          enum:
          - TYPE_UNSPECIFIED
          - STRAIGHT_CONNECTOR_1
          - BENT_CONNECTOR_2
          - BENT_CONNECTOR_3
          - BENT_CONNECTOR_4
          - BENT_CONNECTOR_5
          - CURVED_CONNECTOR_2
          - CURVED_CONNECTOR_3
          - CURVED_CONNECTOR_4
          - CURVED_CONNECTOR_5
          - STRAIGHT_LINE
          example: TYPE_UNSPECIFIED
        lineProperties:
          $ref: '#/components/schemas/LineProperties'
    DeleteTextRequest:
      type: object
      description: Deletes text from a shape or a table cell.
      properties:
        objectId:
          type: string
          description: The object ID of the shape or table where the text will be deleted.
          example: '500123'
        cellLocation:
          $ref: '#/components/schemas/TableCellLocation'
        textRange:
          $ref: '#/components/schemas/Range'
    PageBackgroundFill:
      type: object
      description: The background fill of a page.
      properties:
        propertyState:
          type: string
          description: The background fill property state.
          enum:
          - RENDERED
          - NOT_RENDERED
          - INHERIT
          example: RENDERED
        solidFill:
          $ref: '#/components/schemas/SolidFill'
        stretchedPictureFill:
          $ref: '#/components/schemas/StretchedPictureFill'
    AutoText:
      type: object
      description: 'A TextElement kind that represents auto text.

        '
      properties:
        type:
          type: string
          description: The type of this auto text.
          enum:
          - TYPE_UNSPECIFIED
          - SLIDE_NUMBER
          example: TYPE_UNSPECIFIED
        content:
          type: string
          description: 'The rendered content of this auto text, if available.

            '
          example: example_value
        style:
          $ref: '#/components/schemas/TextStyle'
    SlideProperties:
      type: object
      description: 'The properties of a Page that are only relevant for pages with pageType SLIDE.

        '
      properties:
        layoutObjectId:
          type: string
          description: 'The object ID of the layout that this slide is based on.

            '
          example: '500123'
        masterObjectId:
          type: string
          description: 'The object ID of the master that this slide is based on.

            '
          example: '500123'
        notesPage:
          $ref: '#/components/schemas/Page'
        isSkipped:
          type: boolean
          description: Whether the slide is skipped in the presentation mode.
          example: true
    ReplaceAllTextResponse:
      type: object
      description: The result of replacing text.
      properties:
        occurrencesChanged:
          type: integer
          description: The number of occurrences changed by replacing all text.
          example: 10
    ColorStop:
      type: object
      description: A color and position in a gradient band.
      properties:
        color:
          $ref: '#/components/schemas/OpaqueColor'
        alpha:
          type: number
          description: 'The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque.

            '
          example: 42.5
        position:
          type: number
          description: 'The relative position of the color stop in the gradient band measured in percentage.

            '
          example: 42.5
    ImageProperties:
      type: object
      description: The properties of an Image.
      properties:
        cropProperties:
          $ref: '#/components/schemas/CropProperties'
        transparency:
          type: number
          description: 'The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

            '
          example: 42.5
        brightness:
          type: number
          description: 'The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

            '
          example: 42.5
        contrast:
          type: number
          description: 'The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

            '
          example: 42.5
        recolor:
          $ref: '#/components/schemas/Recolor'
        outline:
          $ref: '#/components/schemas/Outline'
        shadow:
          $ref: '#/components/schemas/Shadow'
        link:
          $ref: '#/components/schemas/Link'
    Presentation:
      type: object
      description: A Google Slides presentation.
      properties:
        presentationId:
          type: string
          description: The ID of the presentation.
          readOnly: true
          example: '500123'
        title:
          type: string
          description: The title of the presentation.
          example: Example Title
        pageSize:
          $ref: '#/components/schemas/Size'
        slides:
          type: array
          description: 'The slides in the presentation. A slide inherits properties from a slide layout.

            '
          items:
            $ref: '#/components/schemas/Page'
          readOnly: true
          example: []
        masters:
          type: array
          description: 'The slide masters in the presentation. A slide master contains all common page elements and the common properties for a set of layouts.

            '
          items:
            $ref: '#/components/schemas/Page'
          readOnly: true
          example: []
        layouts:
          type: array
          description: 'The layouts in the presentation. A layout is a template that determines how content is arranged and styled on the slides that inherit from that layout.

            '
          items:
            $ref: '#/components/schemas/Page'
          readOnly: true
          example: []
        locale:
          type: string
          description: 'The locale of the presentation as an IETF BCP 47 language tag.

            '
          example: example_value
        revisionId:
          type: string
          description: 'Output only. The revision ID of the presentation. Can be used in update requests to assert that the presentation revision has not changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format may change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users.

            '
          readOnly: true
          example: '500123'
        notesMaster:
          $ref: '#/components/schemas/Page'
          description: 'The notes master in the presentation. It serves as the template for the notes pages of all slides.

            '
          readOnly: true
    TableCellBackgroundFill:
      type: object
      description: The table cell background fill.
      properties:
        propertyState:
          type: string
          description: The background fill property state.
          enum:
          - RENDERED
          - NOT_RENDERED
          - INHERIT
          example: RENDERED
        solidFill:
          $ref: '#/components/schemas/SolidFill'
    RgbColor:
      type: object
      description: An RGB color.
      properties:
        red:
          type: number
          description: The red component of the color, from 0.0 to 1.0.
          example: 42.5
        green:
          type: number
          description: The green component of the color, from 0.0 to 1.0.
          example: 42.5
        blue:
          type: number
          description: The blue component of the color, from 0.0 to 1.0.
          example: 42.5
    UpdateParagraphStyleRequest:
      type: object
      description: Updates the styling of paragraphs within a Shape or Table.
      properties:
        objectId:
          type: string
          description: The object ID of the shape or table.
          example: '500123'
        cellLocation:
          $ref: '#/components/schemas/TableCellLocation'
        style:
          $ref: '#/components/schemas/ParagraphStyle'
        textRange:
          $ref: '#/components/schemas/Range'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
    ReplaceAllShapesWithSheetsChartResponse:
      type: object
      description: The result of replacing shapes with a Sheets chart.
      properties:
        occurrencesChanged:
          type: integer
          description: The number of shapes replaced.
          example: 10
    TableBorderFill:
      type: object
      description: The fill of a table border.
      properties:
        solidFill:
          $ref: '#/components/schemas/SolidFill'
    CreateVideoRequest:
      type: object
      description: Creates a video.
      properties:
        objectId:
          type: string
          description: A user-supplied object ID.
          example: '500123'
        elementProperties:
          $ref: '#/components/schemas/PageElementProperties'
        source:
          type: string
          description: The video source.
          enum:
          - SOURCE_UNSPECIFIED
          - YOUTUBE
          - DRIVE
          - GOOGLE_MEET
          example: SOURCE_UNSPECIFIED
        id:
          type: string
          description: 'The video source''s unique identifier for this video.

            '
          example: abc123
    CreateShapeRequest:
      type: object
      description: Creates a new shape.
      properties:
        objectId:
          type: string
          description: A user-supplied object ID.
          example: '500123'
        elementProperties:
          $ref: '#/components/schemas/PageElementProperties'
        shapeType:
          type: string
          description: The shape type.
          example: example_value
    UngroupObjectsRequest:
      type: object
      description: Ungroups objects, such as groups.
      properties:
        objectIds:
          type: array
          description: 'The object IDs of the objects to ungroup. Only groups that are not inside other groups can be ungrouped.

            '
          items:
            type: string
          example: []
    UpdateLinePropertiesRequest:
      type: object
      description: Updates the properties of a Line.
      properties:
        objectId:
          type: string
          description: The object ID of the line.
          example: '500123'
        lineProperties:
          $ref: '#/components/schemas/LineProperties'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
    SolidFill:
      type: object
      description: A solid color fill.
      properties:
        color:
          $ref: '#/components/schemas/OpaqueColor'
        alpha:
          type: number
          description: 'The fraction of this color that should be applied to the pixel. The final pixel color is defined by the equation pixel_color = alpha * this_color + (1.0 - alpha) * pixel_color. Value is in [0.0, 1.0].

            '
          example: 42.5
    UpdateTextStyleRequest:
      type: object
      description: 'Update the styling of text in a Shape or Table.

        '
      properties:
        objectId:
          type: string
          description: The object ID of the shape or table with the text to be styled.
          example: '500123'
        cellLocation:
          $ref: '#/components/schemas/TableCellLocation'
        style:
          $ref: '#/components/schemas/TextStyle'
        textRange:
          $ref: '#/components/schemas/Range'
        fields:
          type: string
          description: The fields that should be updated.
          example: example_value
    ThemeColorPair:
      type: object
      description: A pair mapping a theme color type to the concrete color it represents.
      properties:
        type:
          type: string
          description: The type of the theme color.
          enum:
          - THEME_COLOR_TYPE_UNSPECIFIED
          - DARK1
          - LIGHT1
          - DARK2
          - LIGHT2
          - ACCENT1
          - ACCENT2
          - ACCENT3
          - ACCENT4
          - ACCENT5
          - ACCENT6
          - HYPERLINK
          - FOLLOWED_HYPERLINK
          - TEXT1
          - BACKGROUND1
          - TEXT2
          - BACKGROUND2
          example: THEME_COLOR_TYPE_UNSPECIFIED
        color:
          $ref: '#/components/schemas/RgbColor'
    Image:
      type: object
      description: 'A PageElement kind representing an image.

        '
      properties:
        contentUrl:
          type: string
          description: 'An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester.

            '
          readOnly: true
          example: https://www.example.com
        sourceUrl:
          type: string
          description: 'The source URL is the URL used to insert the image. The source URL can be empty.

            '
          example: https://www.example.com
        imageProperties:
          $ref: '#/components/schemas/ImageProperties'
        placeholder:
          $ref: '#/components/schemas/Placeholder'
    AffineTransform:
      type: object
      description: 'A 3x3 matrix that represents an affine transformation. The matrix maps a source coordinate (x, y) to a destination coordinate (x'', y'') according to matrix multiplication.

        '
      properties:
        scaleX:
          type: number
          description: The X coordinate scaling element.
          example: 42.5
        scaleY:
          type: number
          description: The Y coordinate scaling element.
          example: 42.5
        shearX:
          type: number
          description: The X coordinate shearing element.
          example: 42.5
        shearY:
          type: number
          description: The Y coordinate shearing element.
          example: 42.5
        translateX:
          type: number
          description: The X coordinate translation element.
          example: 42.5
        translateY:
          type: number
          description: The Y coordinate translation element.
          example: 42.5
        unit:
          type: string
          description: The units for translate elements.
          enum:
          - UNIT_UNSPECIFIED
          - EMU
          - PT
          example: UNIT_UNSPECIFIED
    TextRun:
      type: object
      description: 'A TextElement kind that represents a run of text that all has the same styling.

        '
      properties:
        content:
          type: string
          description: The text of this run.
          example: example_value
        style:
          $ref: '#/components/schemas/TextStyle'
    ReplaceAllTextRequest:
      type: object
      description: 'Replaces all instances of text matching a criteria with replace text.

        '
      properties:
        replaceText:
          type: string
          description: The text that will replace the matched text.
          example: example_value
        containsText:
          $ref: '#/components/schemas/SubstringMatchCriteria'
        pageObjectIds:
          type: array
          description: 'If non-empty, limits the matches to page elements only on the given pages.

            '
          items:
            type: string
          example: []
    StretchedPictureFill:

# --- truncated at 32 KB (100 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/google-slides/refs/heads/main/openapi/google-slides-presentations-api-openapi.yml