> ## Documentation Index
> Fetch the complete documentation index at: https://docs.diagramkit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# GIF of an animated diagram



## OpenAPI

````yaml /openapi.json get /diagrams/{id}/animation.gif
openapi: 3.1.0
info:
  title: diagramkit API
  version: '1'
  description: >-
    Make, change, animate and download diagrams. Full reference: /docs/api.md on
    diagramkit’s site.
servers:
  - url: https://app.diagramkit.ai/api/v1
security:
  - bearer: []
paths:
  /diagrams/{id}/animation.gif:
    get:
      summary: GIF of an animated diagram
      operationId: downloadGif
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: quality
          in: query
          required: false
          schema:
            type: string
            enum:
              - low
              - medium
              - high
            default: medium
          description: Resolution and frame rate.
        - name: size
          in: query
          required: false
          schema:
            type: string
            enum:
              - chat
              - square
              - portrait
              - story
              - landscape
              - wide
          description: >-
            The frame the animation is fitted into. Left out, the frame of the
            diagram's preset (ad square, social portrait, blog, data_story and
            explainer_video landscape), or chat.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
          description: >-
            One page of a multi-page diagram. Left out, every page plays in
            order in one video; a long set's still pages hold for less so it
            fits (at least 1.5 seconds), and one too long even so is refused
            with 422 too_long, saying how many pages fit.
      responses:
        '200':
          description: The file.
          headers:
            X-Download-Url:
              description: >-
                A link to the same file that works without a key for 15 minutes,
                for a browser, build step or coding agent to GET. Only this file
                of this diagram, at this version.
              schema:
                type: string
                format: uri
            X-Download-Expires-At:
              description: When the link stops working.
              schema:
                type: string
                format: date-time
          content:
            image/gif:
              schema:
                type: string
                format: binary
        default:
          description: An error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            message:
              type: string
            issues:
              type: array
              items:
                type: string
          required:
            - type
            - message
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: An API key (aid_…) from Settings › API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.